Summary

This PR introduces a new experimental API for bidirectional communication between Saleor dashboard forms and apps. This enables apps to receive form context and update form fields programmatically.

Key Features

New Form Communication API

• Form Payload Event: Apps can now receive form data through the formPayload event, including current field values, metadata, and form context
• Form Update Action: Apps can update form fields using the formPayloadUpdate action, allowing them to:
  • Set field values
  • Control popup closure behavior
  • Selectively update only the fields they need (fields parameter is optional)

Supported Forms

• Product Edit: Access and update product name and description fields
• Product Translate: Access and update translated content including product name, description, and SEO fields with translation context (original, translated, and current values)

Type-Safe Implementation

• Strongly typed payloads for each form type
• Discriminated unions for type safety
• Support for different field types (short-text, editorjs)

Technical Changes

New Files

• src/app-bridge/form-payload.ts: Core types and constants for form communication

Modified Files

• src/app-bridge/actions.ts: Added FormPayloadUpdate action
• src/app-bridge/events.ts: Added FormDataEvent for form payload
• src/app-bridge/app-bridge-state.ts: Updated state management
• Various test files with comprehensive coverage
• Platform adapter updates for type compatibility

Example Usage

// Receive form data
appBridge.subscribe("formPayload", (payload) => {
  if (payload.form === "product-translate") {
    const { productName, productDescription } = payload.fields;
    // Process translation data
  }
});

// Update form fields (fields parameter is optional - only update what you need)
appBridge.dispatch(
  actions.FormPayloadUpdate({
    form: "product-translate",
    fields: {
      productName: { value: "Translated name" },
      productDescription: { value: "Translated description" }
    },
    closePopup: true
  })
);

Notes

This is an experimental API and may be subject to changes based on feedback and usage patterns.